home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / stgex2.z / stgex2
Encoding:
Text File  |  2002-10-03  |  6.6 KB  |  199 lines

  1.  
  2.  
  3.  
  4. SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))                                                          SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      STGEX2 - swap adjacent diagonal blocks (A11, B11) and (A22, B22) of size
  10.      1-by-1 or 2-by-2 in an upper (quasi) triangular matrix pair (A, B) by an
  11.      orthogonal equivalence transformation
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE STGEX2( WANTQ, WANTZ, N, A, LDA, B, LDB, Q, LDQ, Z, LDZ, J1,
  15.                         N1, N2, WORK, LWORK, INFO )
  16.  
  17.          LOGICAL        WANTQ, WANTZ
  18.  
  19.          INTEGER        INFO, J1, LDA, LDB, LDQ, LDZ, LWORK, N, N1, N2
  20.  
  21.          REAL           A( LDA, * ), B( LDB, * ), Q( LDQ, * ), WORK( * ), Z(
  22.                         LDZ, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      STGEX2 swaps adjacent diagonal blocks (A11, B11) and (A22, B22) of size
  39.      1-by-1 or 2-by-2 in an upper (quasi) triangular matrix pair (A, B) by an
  40.      orthogonal equivalence transformation. (A, B) must be in generalized real
  41.      Schur canonical form (as returned by SGGES), i.e. A is block upper
  42.      triangular with 1-by-1 and 2-by-2 diagonal blocks. B is upper triangular.
  43.  
  44.      Optionally, the matrices Q and Z of generalized Schur vectors are
  45.      updated.
  46.  
  47.             Q(in) * A(in) * Z(in)' = Q(out) * A(out) * Z(out)'
  48.             Q(in) * B(in) * Z(in)' = Q(out) * B(out) * Z(out)'
  49.  
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      WANTQ   (input) LOGICAL
  54.  
  55.      WANTZ   (input) LOGICAL
  56.  
  57.      N       (input) INTEGER
  58.              The order of the matrices A and B. N >= 0.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))                                                          SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A      (input/output) REAL arrays, dimensions (LDA,N)
  75.             On entry, the matrix A in the pair (A, B).  On exit, the updated
  76.             matrix A.
  77.  
  78.      LDA     (input)  INTEGER
  79.              The leading dimension of the array A. LDA >= max(1,N).
  80.  
  81.      B      (input/output) REAL arrays, dimensions (LDB,N)
  82.             On entry, the matrix B in the pair (A, B).  On exit, the updated
  83.             matrix B.
  84.  
  85.      LDB     (input)  INTEGER
  86.              The leading dimension of the array B. LDB >= max(1,N).
  87.  
  88.      Q       (input/output) REAL array, dimension (LDZ,N)
  89.              On entry, if WANTQ = .TRUE., the orthogonal matrix Q.  On exit,
  90.              the updated matrix Q.  Not referenced if WANTQ = .FALSE..
  91.  
  92.      LDQ     (input) INTEGER
  93.              The leading dimension of the array Q. LDQ >= 1.  If WANTQ =
  94.              .TRUE., LDQ >= N.
  95.  
  96.      Z       (input/output) REAL array, dimension (LDZ,N)
  97.              On entry, if WANTZ =.TRUE., the orthogonal matrix Z.  On exit,
  98.              the updated matrix Z.  Not referenced if WANTZ = .FALSE..
  99.  
  100.      LDZ     (input) INTEGER
  101.              The leading dimension of the array Z. LDZ >= 1.  If WANTZ =
  102.              .TRUE., LDZ >= N.
  103.  
  104.      J1      (input) INTEGER
  105.              The index to the first block (A11, B11). 1 <= J1 <= N.
  106.  
  107.      N1      (input) INTEGER
  108.              The order of the first block (A11, B11). N1 = 0, 1 or 2.
  109.  
  110.      N2      (input) INTEGER
  111.              The order of the second block (A22, B22). N2 = 0, 1 or 2.
  112.  
  113.      WORK    (workspace) REAL array, dimension (LWORK).
  114.  
  115.      LWORK   (input) INTEGER
  116.              The dimension of the array WORK.  LWORK >=  MAX( N*(N2+N1),
  117.              (N2+N1)*(N2+N1)*2 )
  118.  
  119.      INFO    (output) INTEGER
  120.              =0: Successful exit
  121.              >0: If INFO = 1, the transformed matrix (A, B) would be too far
  122.              from generalized Schur form; the blocks are not swapped and (A,
  123.              B) and (Q, Z) are unchanged.  The problem of swapping is too
  124.              ill-conditioned.  <0: If INFO = -16: LWORK is too small.
  125.              Appropriate value for LWORK is returned in WORK(1).
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))                                                          SSSSTTTTGGGGEEEEXXXX2222((((3333SSSS))))
  137.  
  138.  
  139.  
  140. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  141.      Based on contributions by
  142.         Bo Kagstrom and Peter Poromaa, Department of Computing Science,
  143.         Umea University, S-901 87 Umea, Sweden.
  144.  
  145.      In the current code both weak and strong stability tests are performed.
  146.      The user can omit the strong stability test by changing the internal
  147.      logical parameter WANDS to .FALSE.. See ref. [2] for details.
  148.  
  149.      [1] B. Kagstrom; A Direct Method for Reordering Eigenvalues in the
  150.          Generalized Real Schur Form of a Regular Matrix Pair (A, B), in
  151.          M.S. Moonen et al (eds), Linear Algebra for Large Scale and
  152.          Real-Time Applications, Kluwer Academic Publ. 1993, pp 195-218.
  153.  
  154.      [2] B. Kagstrom and P. Poromaa; Computing Eigenspaces with Specified
  155.          Eigenvalues of a Regular Matrix Pair (A, B) and Condition
  156.          Estimation: Theory, Algorithms and Software,
  157.          Report UMINF - 94.04, Department of Computing Science, Umea
  158.          University, S-901 87 Umea, Sweden, 1994. Also as LAPACK Working
  159.          Note 87. To appear in Numerical Algorithms, 1996.
  160.  
  161.  
  162. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  163.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  164.  
  165.      This man page is available only online.
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.